Skip to main content
Version: 2.1.x

gredis 组件支持两种方式来管理 redis 配置和获取 redis 对象，一种是通过 配置组件+单例对象 的方式；一种是模块化通过 配置管理方法 及对象创建方法。

配置文件（推荐）​

绝大部分情况下推荐使用 g.Redis 单例方式来操作 redis。因此同样推荐使用配置文件来管理 Redis 配置，在 config.yaml 中的配置示例如下：

单实例配置​

# Redis 配置示例
redis:
  # 单实例配置示例1
  default:
    address: 127.0.0.1:6379
    db:      1

  # 单实例配置示例2
  cache:
    address:     127.0.0.1:6379
    db:          1
    pass:        123456
    idleTimeout: 600

集群化配置​

# Redis 配置示例
redis:
   # 集群模式配置方法
  group:
    address: 127.0.0.1:6379,127.0.0.1:6370
    db:      1

配置项说明​

配置项名称是否必须默认值说明
address是-格式： 地址:端口
支持 Redis 单实例模式和集群模式配置，使用 , 分割多个地址。例如：
192.168.1.1:6379, 192.168.1.2:6379
db否0数据库索引
pass否-访问授权密码
minIdle否0允许闲置的最小连接数
maxIdle否10允许闲置的最大连接数( 0 表示不限制)
maxActive否100最大连接数量限制( 0 表示不限制)
idleTimeout否10连接最大空闲时间，使用时间字符串例如 30s/1m/1d
maxConnLifetime否30连接最长存活时间，使用时间字符串例如 30s/1m/1d
waitTimeout否0等待连接池连接的超时时间，使用时间字符串例如 30s/1m/1d
dialTimeout否0TCP 连接的超时时间，使用时间字符串例如 30s/1m/1d
readTimeout否0TCP 的 Read 操作超时时间，使用时间字符串例如 30s/1m/1d
writeTimeout否0TCP 的 Write 操作超时时间，使用时间字符串例如 30s/1m/1d
masterName否-哨兵模式下使用, 设置 MasterName
tls否false是否使用 TLS 认证
tlsSkipVerify否false通过 TLS 连接时，是否禁用服务器名称验证

使用示例：

func main() {
    var (
        ctx = context.Background()
    )
    conn, _ := g.Redis().Conn(ctx)
    conn.Do(ctx, "SET", "Key", "Value")
    v, _ := conn.Do(ctx, "GET", "Key")
    fmt.Println(v.String())
}

其中的 default 和 cache 分别表示配置分组名称，我们在程序中可以通过该名称获取对应配置的 redis 单例对象。不传递分组名称时，默认使用 redis.default 配置分组项)来获取对应配置的 redis 客户端单例对象。 执行后，输出结果为：

配置方法（高级）​

由于 GoFrame 是模块化的框架，除了可以通过耦合且便捷的 g 模块来自动解析配置文件并获得单例对象之外，也支持有能力的开发者模块化使用 gredis 包。

gredis 提供了全局的分组配置功能，相关配置管理方法如下：

func SetConfig(config Config, name ...string)
func SetConfigByMap(m map[string]interface{}, name ...string) error
func GetConfig(name ...string) (config Config, ok bool)
func RemoveConfig(name ...string)
func ClearConfig()

其中 name 参数为分组名称，即为通过分组来对配置对象进行管理，我们可以为不同的配置对象设置不同的分组名称，随后我们可以通过 Instance 单例方法获取 redis 客户端操作对象单例。

func Instance(name ...string) *Redis

使用示例：

package main

import (
    "context"
    "fmt"
    "github.com/gogf/gf/v2/database/gredis"
    "github.com/gogf/gf/v2/util/gconv"
)

var (
    config = gredis.Config{
        Address: "192.168.1.2:6379, 192.168.1.3:6379",
        Db   : 1,
    }
    ctx = context.Background()
)

func main() {
    group := "test"
    gredis.SetConfig(&config, group)

    redis := gredis.Instance(group)
    defer redis.Close(ctx)

    _, err := redis.Do(ctx, "SET", "k", "v")
    if err != nil {
        panic(err)
    }

    r, err := redis.Do(ctx, "GET", "k")
    if err != nil {
        panic(err)
    }
    fmt.Println(gconv.String(r))
}